Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Getting Started update #774

Merged
merged 12 commits into from
Jan 30, 2025
Merged

Getting Started update #774

merged 12 commits into from
Jan 30, 2025

Conversation

SRaimondi
Copy link
Contributor

Updated the Getting Started section of the documentation such that it can be done from a user (solves #771), Code to download the examples file has also been added.

@SRaimondi SRaimondi added the documentation Improvements or additions to documentation label Jan 29, 2025
@SRaimondi SRaimondi self-assigned this Jan 29, 2025
Copy link

codecov bot commented Jan 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.98%. Comparing base (f1924cb) to head (7b60973).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #774   +/-   ##
=======================================
  Coverage   94.98%   94.98%           
=======================================
  Files         109      109           
  Lines        5698     5700    +2     
  Branches      323      323           
=======================================
+ Hits         5412     5414    +2     
  Misses        285      285           
  Partials        1        1           
Flag Coverage Δ
direct-launch 91.57% <100.00%> (+<0.01%) ⬆️
minimum-deps 93.14% <100.00%> (+<0.01%) ⬆️
python-3.10 94.21% <100.00%> (+<0.01%) ⬆️
python-3.11 94.14% <100.00%> (+<0.01%) ⬆️
python-3.12 94.33% <100.00%> (+<0.01%) ⬆️
server-2024R2 90.77% <100.00%> (+<0.01%) ⬆️
server-2025R1 94.14% <100.00%> (+<0.01%) ⬆️
server-2025R2 94.14% <100.00%> (+<0.01%) ⬆️
server-latest 94.78% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

doc/source/intro.rst Outdated Show resolved Hide resolved
src/ansys/acp/core/extras/example_helpers.py Outdated Show resolved Hide resolved
doc/source/intro.rst Outdated Show resolved Hide resolved
doc/source/intro.rst Outdated Show resolved Hide resolved
@greschd
Copy link
Member

greschd commented Jan 29, 2025

Looks good to me overall, I just added some comments regarding variable names for the example files.

Copy link
Member

@greschd greschd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two more minor suggestions, apologies for not catching those on the first review.

doc/source/intro.rst Outdated Show resolved Hide resolved
doc/source/intro.rst Outdated Show resolved Hide resolved
@SRaimondi SRaimondi merged commit 8bbe922 into main Jan 30, 2025
33 checks passed
@SRaimondi SRaimondi deleted the docs/getting_started_file branch January 30, 2025 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants